3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
20 * @author Alexandre Emsenhuber
21 * @author Daniel Friesen
25 use MediaWiki\Logger\LoggerFactory
;
26 use MediaWiki\MediaWikiServices
;
27 use Wikimedia\ScopedCallback
;
30 * Group all the pieces relevant to the context of a request into one instance
32 class RequestContext
implements IContextSource
, MutableContext
{
81 private static $instance = null;
84 * @param Config $config
86 public function setConfig( Config
$config ) {
87 $this->config
= $config;
93 public function getConfig() {
94 if ( $this->config
=== null ) {
95 // @todo In the future, we could move this to WebStart.php so
96 // the Config object is ready for when initialization happens
97 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
100 return $this->config
;
104 * Set the WebRequest object
106 * @param WebRequest $r
108 public function setRequest( WebRequest
$r ) {
113 * Get the WebRequest object
117 public function getRequest() {
118 if ( $this->request
=== null ) {
119 global $wgCommandLineMode;
120 // create the WebRequest object on the fly
121 if ( $wgCommandLineMode ) {
122 $this->request
= new FauxRequest( [] );
124 $this->request
= new WebRequest();
128 return $this->request
;
132 * Get the Stats object
134 * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
136 * @return IBufferingStatsdDataFactory
138 public function getStats() {
139 return MediaWikiServices
::getInstance()->getStatsdDataFactory();
143 * Get the timing object
147 public function getTiming() {
148 if ( $this->timing
=== null ) {
149 $this->timing
= new Timing( [
150 'logger' => LoggerFactory
::getInstance( 'Timing' )
153 return $this->timing
;
157 * Set the Title object
159 * @param Title|null $title
161 public function setTitle( Title
$title = null ) {
162 $this->title
= $title;
163 // Erase the WikiPage so a new one with the new title gets created.
164 $this->wikipage
= null;
168 * Get the Title object
172 public function getTitle() {
173 if ( $this->title
=== null ) {
174 global $wgTitle; # fallback to $wg till we can improve this
175 $this->title
= $wgTitle;
178 __METHOD__
. ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
186 * Check, if a Title object is set
191 public function hasTitle() {
192 return $this->title
!== null;
196 * Check whether a WikiPage object can be get with getWikiPage().
197 * Callers should expect that an exception is thrown from getWikiPage()
198 * if this method returns false.
203 public function canUseWikiPage() {
204 if ( $this->wikipage
) {
205 // If there's a WikiPage object set, we can for sure get it
208 // Only pages with legitimate titles can have WikiPages.
209 // That usually means pages in non-virtual namespaces.
210 $title = $this->getTitle();
211 return $title ?
$title->canExist() : false;
215 * Set the WikiPage object
220 public function setWikiPage( WikiPage
$p ) {
221 $pageTitle = $p->getTitle();
222 if ( !$this->hasTitle() ||
!$pageTitle->equals( $this->getTitle() ) ) {
223 $this->setTitle( $pageTitle );
225 // Defer this to the end since setTitle sets it to null.
226 $this->wikipage
= $p;
230 * Get the WikiPage object.
231 * May throw an exception if there's no Title object set or the Title object
232 * belongs to a special namespace that doesn't have WikiPage, so use first
233 * canUseWikiPage() to check whether this method can be called safely.
236 * @throws MWException
239 public function getWikiPage() {
240 if ( $this->wikipage
=== null ) {
241 $title = $this->getTitle();
242 if ( $title === null ) {
243 throw new MWException( __METHOD__
. ' called without Title object set' );
245 $this->wikipage
= WikiPage
::factory( $title );
248 return $this->wikipage
;
252 * @param OutputPage $o
254 public function setOutput( OutputPage
$o ) {
259 * Get the OutputPage object
263 public function getOutput() {
264 if ( $this->output
=== null ) {
265 $this->output
= new OutputPage( $this );
268 return $this->output
;
272 * Set the User object
276 public function setUser( User
$u ) {
281 * Get the User object
285 public function getUser() {
286 if ( $this->user
=== null ) {
287 $this->user
= User
::newFromSession( $this->getRequest() );
294 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
295 * code and replaces with $wgLanguageCode if not sane.
296 * @param string $code Language code
299 public static function sanitizeLangCode( $code ) {
300 global $wgLanguageCode;
302 // BCP 47 - letter case MUST NOT carry meaning
303 $code = strtolower( $code );
306 if ( !$code ||
!Language
::isValidCode( $code ) ||
$code === 'qqq' ) {
307 $code = $wgLanguageCode;
314 * Set the Language object
316 * @param Language|string $l Language instance or language code
317 * @throws MWException
320 public function setLanguage( $l ) {
321 if ( $l instanceof Language
) {
323 } elseif ( is_string( $l ) ) {
324 $l = self
::sanitizeLangCode( $l );
325 $obj = Language
::factory( $l );
328 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
333 * Get the Language object.
334 * Initialization of user or request objects can depend on this.
339 public function getLanguage() {
340 if ( isset( $this->recursion
) ) {
341 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
343 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
345 $code = $this->getConfig()->get( 'LanguageCode' ) ?
: 'en';
346 $this->lang
= Language
::factory( $code );
347 } elseif ( $this->lang
=== null ) {
348 $this->recursion
= true;
353 $request = $this->getRequest();
354 $user = $this->getUser();
356 $code = $request->getVal( 'uselang', 'user' );
357 if ( $code === 'user' ) {
358 $code = $user->getOption( 'language' );
360 $code = self
::sanitizeLangCode( $code );
362 Hooks
::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
364 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
365 $this->lang
= $wgContLang;
367 $obj = Language
::factory( $code );
371 unset( $this->recursion
);
373 catch ( Exception
$ex ) {
374 unset( $this->recursion
);
383 * Set the Skin object
387 public function setSkin( Skin
$s ) {
388 $this->skin
= clone $s;
389 $this->skin
->setContext( $this );
393 * Get the Skin object
397 public function getSkin() {
398 if ( $this->skin
=== null ) {
400 Hooks
::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
401 $factory = SkinFactory
::getDefaultInstance();
403 // If the hook worked try to set a skin from it
404 if ( $skin instanceof Skin
) {
406 } elseif ( is_string( $skin ) ) {
407 // Normalize the key, just in case the hook did something weird.
408 $normalized = Skin
::normalizeKey( $skin );
409 $this->skin
= $factory->makeSkin( $normalized );
412 // If this is still null (the hook didn't run or didn't work)
413 // then go through the normal processing to load a skin
414 if ( $this->skin
=== null ) {
415 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
417 $userSkin = $this->getUser()->getOption( 'skin' );
418 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
420 # if we're not allowing users to override, then use the default
421 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
424 // Normalize the key in case the user is passing gibberish
425 // or has old preferences (T71566).
426 $normalized = Skin
::normalizeKey( $userSkin );
428 // Skin::normalizeKey will also validate it, so
429 // this won't throw an exception
430 $this->skin
= $factory->makeSkin( $normalized );
433 // After all that set a context on whatever skin got created
434 $this->skin
->setContext( $this );
440 /** Helpful methods **/
443 * Get a Message object with context set
444 * Parameters are the same as wfMessage()
446 * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
447 * or a MessageSpecifier.
448 * @param mixed $args,...
451 public function msg( $key ) {
452 $args = func_get_args();
454 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
457 /** Static methods **/
460 * Get the RequestContext object associated with the main request
462 * @return RequestContext
464 public static function getMain() {
465 if ( self
::$instance === null ) {
466 self
::$instance = new self
;
469 return self
::$instance;
473 * Get the RequestContext object associated with the main request
474 * and gives a warning to the log, to find places, where a context maybe is missing.
476 * @param string $func
477 * @return RequestContext
480 public static function getMainAndWarn( $func = __METHOD__
) {
481 wfDebug( $func . ' called without context. ' .
482 "Using RequestContext::getMain() for sanity\n" );
484 return self
::getMain();
488 * Resets singleton returned by getMain(). Should be called only from unit tests.
490 public static function resetMain() {
491 if ( !( defined( 'MW_PHPUNIT_TEST' ) ||
defined( 'MW_PARSER_TEST' ) ) ) {
492 throw new MWException( __METHOD__
. '() should be called only from unit tests!' );
494 self
::$instance = null;
498 * Export the resolved user IP, HTTP headers, user ID, and session ID.
499 * The result will be reasonably sized to allow for serialization.
504 public function exportSession() {
505 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
507 'ip' => $this->getRequest()->getIP(),
508 'headers' => $this->getRequest()->getAllHeaders(),
509 'sessionId' => $session->isPersistent() ?
$session->getId() : '',
510 'userId' => $this->getUser()->getId()
515 * Import an client IP address, HTTP headers, user ID, and session ID
517 * This sets the current session, $wgUser, and $wgRequest from $params.
518 * Once the return value falls out of scope, the old context is restored.
519 * This method should only be called in contexts where there is no session
520 * ID or end user receiving the response (CLI or HTTP job runners). This
521 * is partly enforced, and is done so to avoid leaking cookies if certain
522 * error conditions arise.
524 * This is useful when background scripts inherit context when acting on
525 * behalf of a user. In general the 'sessionId' parameter should be set
526 * to an empty string unless session importing is *truly* needed. This
527 * feature is somewhat deprecated.
529 * @note suhosin.session.encrypt may interfere with this method.
531 * @param array $params Result of RequestContext::exportSession()
532 * @return ScopedCallback
533 * @throws MWException
536 public static function importScopedSession( array $params ) {
537 if ( strlen( $params['sessionId'] ) &&
538 MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent()
540 // Sanity check to avoid sending random cookies for the wrong users.
541 // This method should only called by CLI scripts or by HTTP job runners.
542 throw new MWException( "Sessions can only be imported when none is active." );
543 } elseif ( !IP
::isValid( $params['ip'] ) ) {
544 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
547 if ( $params['userId'] ) { // logged-in user
548 $user = User
::newFromId( $params['userId'] );
550 if ( !$user->getId() ) {
551 throw new MWException( "No user with ID '{$params['userId']}'." );
553 } else { // anon user
554 $user = User
::newFromName( $params['ip'], false );
557 $importSessionFunc = function ( User
$user, array $params ) {
558 global $wgRequest, $wgUser;
560 $context = RequestContext
::getMain();
562 // Commit and close any current session
563 if ( MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
564 session_write_close(); // persist
565 session_id( '' ); // detach
566 $_SESSION = []; // clear in-memory array
569 // Get new session, if applicable
571 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
572 $manager = MediaWiki\Session\SessionManager
::singleton();
573 $session = $manager->getSessionById( $params['sessionId'], true )
574 ?
: $manager->getEmptySession();
577 // Remove any user IP or agent information, and attach the request
578 // with the new session.
579 $context->setRequest( new FauxRequest( [], false, $session ) );
580 $wgRequest = $context->getRequest(); // b/c
582 // Now that all private information is detached from the user, it should
583 // be safe to load the new user. If errors occur or an exception is thrown
584 // and caught (leaving the main context in a mixed state), there is no risk
585 // of the User object being attached to the wrong IP, headers, or session.
586 $context->setUser( $user );
587 $wgUser = $context->getUser(); // b/c
588 if ( $session && MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
589 session_id( $session->getId() );
590 MediaWiki\
quietCall( 'session_start' );
592 $request = new FauxRequest( [], false, $session );
593 $request->setIP( $params['ip'] );
594 foreach ( $params['headers'] as $name => $value ) {
595 $request->setHeader( $name, $value );
597 // Set the current context to use the new WebRequest
598 $context->setRequest( $request );
599 $wgRequest = $context->getRequest(); // b/c
602 // Stash the old session and load in the new one
603 $oUser = self
::getMain()->getUser();
604 $oParams = self
::getMain()->exportSession();
605 $oRequest = self
::getMain()->getRequest();
606 $importSessionFunc( $user, $params );
608 // Set callback to save and close the new session and reload the old one
609 return new ScopedCallback(
610 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
612 $importSessionFunc( $oUser, $oParams );
613 // Restore the exact previous Request object (instead of leaving FauxRequest)
614 RequestContext
::getMain()->setRequest( $oRequest );
615 $wgRequest = RequestContext
::getMain()->getRequest(); // b/c
621 * Create a new extraneous context. The context is filled with information
622 * external to the current session.
623 * - Title is specified by argument
624 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
625 * - User is an anonymous user, for separation IPv4 localhost is used
626 * - Language will be based on the anonymous user and request, may be content
627 * language or a uselang param in the fauxrequest data may change the lang
628 * - Skin will be based on the anonymous user, should be the wiki's default skin
630 * @param Title $title Title to use for the extraneous request
631 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
632 * @return RequestContext
634 public static function newExtraneousContext( Title
$title, $request = [] ) {
636 $context->setTitle( $title );
637 if ( $request instanceof WebRequest
) {
638 $context->setRequest( $request );
640 $context->setRequest( new FauxRequest( $request ) );
642 $context->user
= User
::newFromName( '127.0.0.1', false );